LuaCommandProcessor

class LuaCommandProcessor - sort

add_command(name, help, function)	Add a command.
remove_command(string) → boolean	Removes a registered command
commands :: dictionary string → LocalisedString [R]	Commands registered by scripts through `LuaCommandProcessor`.
game_commands :: dictionary string → LocalisedString [R]	Builtin commands of the core game.

Custom game console commands. These don't persist through save and load; instead, scripts are expected to re-register their commands in LuaBootstrap::on_load.

add_command(name, help, function)

Add a command.

Parameters

name :: string: Name of the command (case sensitive).

help :: LocalisedString: The localised help message.

function :: function: The function that will be called when this command is invoked.

Note: It is an error if the given command name is already registered or already exists as a game command.

remove_command(string) → boolean

Removes a registered command

Parameters

Return value

If the command was removed. False if the command didn't exist.

commands :: dictionary string → LocalisedString [Read-only]

Commands registered by scripts through LuaCommandProcessor.

game_commands :: dictionary string → LocalisedString [Read-only]

Builtin commands of the core game.